Cisco-IOS-XR-ip-ntp-cfg API API Reference

API generated from Cisco-IOS-XR-ip-ntp-cfg@2017-10-15.yang

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

NTP - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/

Update operation of resource: ntp

ntp_schema

ntpbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "address-ipv4": "string",
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "authentication-key": "string",
                  "burst": "string",
                  "ntp-version": "string",
                  "min-poll": "integer",
                  "iburst": "string",
                  "max-poll": "integer",
                  "peer-type": "string",
                  "source-interface": "string",
                  "preferred-peer": "string"
                }
              ]
            }
          ]
        },
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "address-ipv6": "string",
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "address-ipv6": "string",
                  "authentication-key": "string",
                  "burst": "string",
                  "ntp-version": "string",
                  "min-poll": "integer",
                  "iburst": "string",
                  "max-poll": "integer",
                  "peer-type": "string",
                  "source-interface": "string",
                  "preferred-peer": "string"
                }
              ]
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "access-group-type": "string",
                "access-list-name": "string"
              }
            ],
            "af": "string"
          }
        ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "authentication-key": "string",
        "burst": "string",
        "ntp-version": "string",
        "min-poll": "integer",
        "iburst": "string",
        "max-poll": "integer",
        "peer-type": "string",
        "preferred-peer": "string"
      }
    ]
  },
  "update-calendar": [ null ],
  "broadcast-delay": "integer",
  "log-internal-sync": [ null ],
  "max-associations": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "aging-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "location": "string",
      "filename": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface": "string",
            "disable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              "broadcast-client": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "broadcast-type": "string",
                    "ntp-version": "string",
                    "authentication-key": "string",
                    "address": "string"
                  }
                ]
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "ip-address": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "version": "string",
                    "authentication-key": "string",
                    "ip-address": "string",
                    "ttl": "string"
                  }
                ]
              }
            }
          }
        ],
        "vrf-name": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : {} 
PUT    POST   DELETE  GET  
  
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NTP - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/

Create operation of resource: ntp

ntp_schema

ntpbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "address-ipv4": "string",
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "authentication-key": "string",
                  "burst": "string",
                  "ntp-version": "string",
                  "min-poll": "integer",
                  "iburst": "string",
                  "max-poll": "integer",
                  "peer-type": "string",
                  "source-interface": "string",
                  "preferred-peer": "string"
                }
              ]
            }
          ]
        },
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "address-ipv6": "string",
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "address-ipv6": "string",
                  "authentication-key": "string",
                  "burst": "string",
                  "ntp-version": "string",
                  "min-poll": "integer",
                  "iburst": "string",
                  "max-poll": "integer",
                  "peer-type": "string",
                  "source-interface": "string",
                  "preferred-peer": "string"
                }
              ]
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "access-group-type": "string",
                "access-list-name": "string"
              }
            ],
            "af": "string"
          }
        ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "authentication-key": "string",
        "burst": "string",
        "ntp-version": "string",
        "min-poll": "integer",
        "iburst": "string",
        "max-poll": "integer",
        "peer-type": "string",
        "preferred-peer": "string"
      }
    ]
  },
  "update-calendar": [ null ],
  "broadcast-delay": "integer",
  "log-internal-sync": [ null ],
  "max-associations": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "aging-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "location": "string",
      "filename": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface": "string",
            "disable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              "broadcast-client": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "broadcast-type": "string",
                    "ntp-version": "string",
                    "authentication-key": "string",
                    "address": "string"
                  }
                ]
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "ip-address": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "version": "string",
                    "authentication-key": "string",
                    "ip-address": "string",
                    "ttl": "string"
                  }
                ]
              }
            }
          }
        ],
        "vrf-name": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : {} 
PUT    POST   DELETE  GET  
  
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NTP - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/

Delete operation of resource: ntp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NTP - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/

Retrieve operation of resource: ntp

200 OK
ntp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "address-ipv4": "string",
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "authentication-key": "string",
                  "burst": "string",
                  "ntp-version": "string",
                  "min-poll": "integer",
                  "iburst": "string",
                  "max-poll": "integer",
                  "peer-type": "string",
                  "source-interface": "string",
                  "preferred-peer": "string"
                }
              ]
            }
          ]
        },
        "vrf-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "address-ipv6": "string",
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "address-ipv6": "string",
                  "authentication-key": "string",
                  "burst": "string",
                  "ntp-version": "string",
                  "min-poll": "integer",
                  "iburst": "string",
                  "max-poll": "integer",
                  "peer-type": "string",
                  "source-interface": "string",
                  "preferred-peer": "string"
                }
              ]
            }
          ]
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "vrf-name": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "access-group-type": "string",
                "access-list-name": "string"
              }
            ],
            "af": "string"
          }
        ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "authentication-key": "string",
        "burst": "string",
        "ntp-version": "string",
        "min-poll": "integer",
        "iburst": "string",
        "max-poll": "integer",
        "peer-type": "string",
        "preferred-peer": "string"
      }
    ]
  },
  "update-calendar": [ null ],
  "broadcast-delay": "integer",
  "log-internal-sync": [ null ],
  "max-associations": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "aging-time": "integer",
    : { 
PUT      POST     DELETE    GET    
    
      "location": "string",
      "filename": "string"
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "interface": "string",
            "disable": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              "broadcast-client": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "broadcast-type": "string",
                    "ntp-version": "string",
                    "authentication-key": "string",
                    "address": "string"
                  }
                ]
              }
            },
            : { 
PUT              POST             DELETE            GET            
            
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "ip-address": "string"
                  }
                ]
              },
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "version": "string",
                    "authentication-key": "string",
                    "ip-address": "string",
                    "ttl": "string"
                  }
                ]
              }
            }
          }
        ],
        "vrf-name": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : {} 
PUT    POST   DELETE  GET  
  
}

ADMIN-TYPES - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/admin-types/

Update operation of resource: admin-types

admin-types_schema

admin-typesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "preferred-peer": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMIN-TYPES - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/admin-types/

Create operation of resource: admin-types

admin-types_schema

admin-typesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "preferred-peer": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMIN-TYPES - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/admin-types/

Delete operation of resource: admin-types

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMIN-TYPES - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/admin-types/

Retrieve operation of resource: admin-types

200 OK
admin-types_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "preferred-peer": "string"
    }
  ]
}

ADMIN-TYPE - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/admin-types/admin-type/{peer-type}/

Update operation of resource: admin-type

admin-type_schema

admin-typebody object

peer-type: string
in path

ID of peer-type

Request Content-Types: application/json
Request Example
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "preferred-peer": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMIN-TYPE - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/admin-types/admin-type/{peer-type}/

Create operation of resource: admin-type

admin-type_schema

admin-typebody object

peer-type: string
in path

ID of peer-type

Request Content-Types: application/json
Request Example
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "preferred-peer": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMIN-TYPE - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/admin-types/admin-type/{peer-type}/

Delete operation of resource: admin-type

peer-type: string
in path

ID of peer-type

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMIN-TYPE - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/admin-types/admin-type/{peer-type}/

Retrieve operation of resource: admin-type

peer-type: string
in path

ID of peer-type

200 OK
admin-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "preferred-peer": "string"
}

PEER-VRFS - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/

Update operation of resource: peer-vrfs

peer-vrfs_schema

peer-vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv4": "string",
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      },
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv6": "string",
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "address-ipv6": "string",
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-VRFS - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/

Create operation of resource: peer-vrfs

peer-vrfs_schema

peer-vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv4": "string",
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      },
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv6": "string",
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "address-ipv6": "string",
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-VRFS - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/

Delete operation of resource: peer-vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-VRFS - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/

Retrieve operation of resource: peer-vrfs

200 OK
peer-vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv4": "string",
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      },
      "vrf-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv6": "string",
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "address-ipv6": "string",
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      }
    }
  ]
}

PEER-VRF - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/

Update operation of resource: peer-vrf

peer-vrf_schema

peer-vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "address-ipv4": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  },
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "address-ipv6": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv6": "string",
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-VRF - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/

Create operation of resource: peer-vrf

peer-vrf_schema

peer-vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "address-ipv4": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  },
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "address-ipv6": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv6": "string",
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-VRF - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/

Delete operation of resource: peer-vrf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-VRF - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/

Retrieve operation of resource: peer-vrf

vrf-name: string
in path

ID of vrf-name

200 OK
peer-vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "address-ipv4": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  },
  "vrf-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "address-ipv6": "string",
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "address-ipv6": "string",
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  }
}

PEER-IPV4S - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/

Update operation of resource: peer-ipv4s

peer-ipv4s_schema

peer-ipv4sbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv4": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV4S - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/

Create operation of resource: peer-ipv4s

peer-ipv4s_schema

peer-ipv4sbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv4": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV4S - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/

Delete operation of resource: peer-ipv4s

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV4S - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/

Retrieve operation of resource: peer-ipv4s

vrf-name: string
in path

ID of vrf-name

200 OK
peer-ipv4s_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv4": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}

PEER-IPV4 - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/peer-ipv4/{address-ipv4}/

Update operation of resource: peer-ipv4

peer-ipv4_schema

peer-ipv4body object

vrf-name: string
in path

ID of vrf-name

address-ipv4: string
in path

ID of address-ipv4

Request Content-Types: application/json
Request Example
{
  "address-ipv4": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV4 - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/peer-ipv4/{address-ipv4}/

Create operation of resource: peer-ipv4

peer-ipv4_schema

peer-ipv4body object

vrf-name: string
in path

ID of vrf-name

address-ipv4: string
in path

ID of address-ipv4

Request Content-Types: application/json
Request Example
{
  "address-ipv4": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV4 - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/peer-ipv4/{address-ipv4}/

Delete operation of resource: peer-ipv4

vrf-name: string
in path

ID of vrf-name

address-ipv4: string
in path

ID of address-ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV4 - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/peer-ipv4/{address-ipv4}/

Retrieve operation of resource: peer-ipv4

vrf-name: string
in path

ID of vrf-name

address-ipv4: string
in path

ID of address-ipv4

200 OK
peer-ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "address-ipv4": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}

PEER-TYPE-IPV4 - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/peer-ipv4/{address-ipv4}/peer-type-ipv4/{peer-type}/

Update operation of resource: peer-type-ipv4

peer-type-ipv4_schema

peer-type-ipv4body object

vrf-name: string
in path

ID of vrf-name

address-ipv4: string
in path

ID of address-ipv4

peer-type: string
in path

ID of peer-type

Request Content-Types: application/json
Request Example
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-TYPE-IPV4 - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/peer-ipv4/{address-ipv4}/peer-type-ipv4/{peer-type}/

Create operation of resource: peer-type-ipv4

peer-type-ipv4_schema

peer-type-ipv4body object

vrf-name: string
in path

ID of vrf-name

address-ipv4: string
in path

ID of address-ipv4

peer-type: string
in path

ID of peer-type

Request Content-Types: application/json
Request Example
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-TYPE-IPV4 - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/peer-ipv4/{address-ipv4}/peer-type-ipv4/{peer-type}/

Delete operation of resource: peer-type-ipv4

vrf-name: string
in path

ID of vrf-name

address-ipv4: string
in path

ID of address-ipv4

peer-type: string
in path

ID of peer-type

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-TYPE-IPV4 - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv4s/peer-ipv4/{address-ipv4}/peer-type-ipv4/{peer-type}/

Retrieve operation of resource: peer-type-ipv4

vrf-name: string
in path

ID of vrf-name

address-ipv4: string
in path

ID of address-ipv4

peer-type: string
in path

ID of peer-type

200 OK
peer-type-ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}

PEER-IPV6S - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/

Update operation of resource: peer-ipv6s

peer-ipv6s_schema

peer-ipv6sbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv6": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "address-ipv6": "string",
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV6S - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/

Create operation of resource: peer-ipv6s

peer-ipv6s_schema

peer-ipv6sbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv6": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "address-ipv6": "string",
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV6S - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/

Delete operation of resource: peer-ipv6s

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV6S - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/

Retrieve operation of resource: peer-ipv6s

vrf-name: string
in path

ID of vrf-name

200 OK
peer-ipv6s_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv6": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "address-ipv6": "string",
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}

PEER-IPV6 - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/peer-ipv6/{address-ipv6}/

Update operation of resource: peer-ipv6

peer-ipv6_schema

peer-ipv6body object

vrf-name: string
in path

ID of vrf-name

address-ipv6: string
in path

ID of address-ipv6

Request Content-Types: application/json
Request Example
{
  "address-ipv6": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv6": "string",
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV6 - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/peer-ipv6/{address-ipv6}/

Create operation of resource: peer-ipv6

peer-ipv6_schema

peer-ipv6body object

vrf-name: string
in path

ID of vrf-name

address-ipv6: string
in path

ID of address-ipv6

Request Content-Types: application/json
Request Example
{
  "address-ipv6": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv6": "string",
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV6 - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/peer-ipv6/{address-ipv6}/

Delete operation of resource: peer-ipv6

vrf-name: string
in path

ID of vrf-name

address-ipv6: string
in path

ID of address-ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-IPV6 - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/peer-ipv6/{address-ipv6}/

Retrieve operation of resource: peer-ipv6

vrf-name: string
in path

ID of vrf-name

address-ipv6: string
in path

ID of address-ipv6

200 OK
peer-ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "address-ipv6": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "address-ipv6": "string",
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}

PEER-TYPE-IPV6 - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/peer-ipv6/{address-ipv6}/peer-type-ipv6/{peer-type}/

Update operation of resource: peer-type-ipv6

peer-type-ipv6_schema

peer-type-ipv6body object

vrf-name: string
in path

ID of vrf-name

address-ipv6: string
in path

ID of address-ipv6

peer-type: string
in path

ID of peer-type

Request Content-Types: application/json
Request Example
{
  "address-ipv6": "string",
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-TYPE-IPV6 - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/peer-ipv6/{address-ipv6}/peer-type-ipv6/{peer-type}/

Create operation of resource: peer-type-ipv6

peer-type-ipv6_schema

peer-type-ipv6body object

vrf-name: string
in path

ID of vrf-name

address-ipv6: string
in path

ID of address-ipv6

peer-type: string
in path

ID of peer-type

Request Content-Types: application/json
Request Example
{
  "address-ipv6": "string",
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-TYPE-IPV6 - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/peer-ipv6/{address-ipv6}/peer-type-ipv6/{peer-type}/

Delete operation of resource: peer-type-ipv6

vrf-name: string
in path

ID of vrf-name

address-ipv6: string
in path

ID of address-ipv6

peer-type: string
in path

ID of peer-type

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PEER-TYPE-IPV6 - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/peer-vrfs/peer-vrf/{vrf-name}/peer-ipv6s/peer-ipv6/{address-ipv6}/peer-type-ipv6/{peer-type}/

Retrieve operation of resource: peer-type-ipv6

vrf-name: string
in path

ID of vrf-name

address-ipv6: string
in path

ID of address-ipv6

peer-type: string
in path

ID of peer-type

200 OK
peer-type-ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "address-ipv6": "string",
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}

DSCP-IPV4 - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/dscp-ipv4/

Update operation of resource: dscp-ipv4

dscp-ipv4_schema

dscp-ipv4body object

Request Content-Types: application/json
Request Example
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DSCP-IPV4 - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/dscp-ipv4/

Create operation of resource: dscp-ipv4

dscp-ipv4_schema

dscp-ipv4body object

Request Content-Types: application/json
Request Example
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DSCP-IPV4 - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/dscp-ipv4/

Delete operation of resource: dscp-ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DSCP-IPV4 - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/dscp-ipv4/

Retrieve operation of resource: dscp-ipv4

200 OK
dscp-ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}

DSCP-IPV6 - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/dscp-ipv6/

Update operation of resource: dscp-ipv6

dscp-ipv6_schema

dscp-ipv6body object

Request Content-Types: application/json
Request Example
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DSCP-IPV6 - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/dscp-ipv6/

Create operation of resource: dscp-ipv6

dscp-ipv6_schema

dscp-ipv6body object

Request Content-Types: application/json
Request Example
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DSCP-IPV6 - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/dscp-ipv6/

Delete operation of resource: dscp-ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DSCP-IPV6 - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/dscp-ipv6/

Retrieve operation of resource: dscp-ipv6

200 OK
dscp-ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}

SOURCES - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/sources/

Update operation of resource: sources

sources_schema

sourcesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "source-interface": "string",
      "vrf-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCES - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/sources/

Create operation of resource: sources

sources_schema

sourcesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "source-interface": "string",
      "vrf-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCES - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/sources/

Delete operation of resource: sources

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCES - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/sources/

Retrieve operation of resource: sources

200 OK
sources_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "source-interface": "string",
      "vrf-name": "string"
    }
  ]
}

SOURCE - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/sources/source/{vrf-name}/

Update operation of resource: source

source_schema

sourcebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "source-interface": "string",
  "vrf-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCE - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/sources/source/{vrf-name}/

Create operation of resource: source

source_schema

sourcebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "source-interface": "string",
  "vrf-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCE - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/sources/source/{vrf-name}/

Delete operation of resource: source

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCE - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/sources/source/{vrf-name}/

Retrieve operation of resource: source

vrf-name: string
in path

ID of vrf-name

200 OK
source_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "source-interface": "string",
  "vrf-name": "string"
}

DRIFT - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/drift/

Update operation of resource: drift

drift_schema

driftbody object

Request Content-Types: application/json
Request Example
{
  "aging-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "location": "string",
    "filename": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DRIFT - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/drift/

Create operation of resource: drift

drift_schema

driftbody object

Request Content-Types: application/json
Request Example
{
  "aging-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "location": "string",
    "filename": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DRIFT - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/drift/

Delete operation of resource: drift

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DRIFT - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/drift/

Retrieve operation of resource: drift

200 OK
drift_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "aging-time": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    "location": "string",
    "filename": "string"
  }
}

FILE - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/drift/file/

Update operation of resource: file

file_schema

filebody object

Request Content-Types: application/json
Request Example
{
  "location": "string",
  "filename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FILE - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/drift/file/

Create operation of resource: file

file_schema

filebody object

Request Content-Types: application/json
Request Example
{
  "location": "string",
  "filename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FILE - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/drift/file/

Delete operation of resource: file

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FILE - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/drift/file/

Retrieve operation of resource: file

200 OK
file_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "location": "string",
  "filename": "string"
}

AUTHENTICATION - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/

Update operation of resource: authentication

authentication_schema

authenticationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "key-number": "string",
        "authentication-key": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "key-number": "string"
      }
    ]
  },
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTHENTICATION - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/

Create operation of resource: authentication

authentication_schema

authenticationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "key-number": "string",
        "authentication-key": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "key-number": "string"
      }
    ]
  },
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTHENTICATION - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/

Delete operation of resource: authentication

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTHENTICATION - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/

Retrieve operation of resource: authentication

200 OK
authentication_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "key-number": "string",
        "authentication-key": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "key-number": "string"
      }
    ]
  },
  "enable": [ null ]
}

KEIES - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/keies/

Update operation of resource: keies

keies_schema

keiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "key-number": "string",
      "authentication-key": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEIES - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/keies/

Create operation of resource: keies

keies_schema

keiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "key-number": "string",
      "authentication-key": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEIES - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/keies/

Delete operation of resource: keies

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEIES - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/keies/

Retrieve operation of resource: keies

200 OK
keies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "key-number": "string",
      "authentication-key": "string"
    }
  ]
}

KEY - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/keies/key/{key-number}/

Update operation of resource: key

key_schema

keybody object

key-number: string
in path

ID of key-number

Request Content-Types: application/json
Request Example
{
  "key-number": "string",
  "authentication-key": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEY - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/keies/key/{key-number}/

Create operation of resource: key

key_schema

keybody object

key-number: string
in path

ID of key-number

Request Content-Types: application/json
Request Example
{
  "key-number": "string",
  "authentication-key": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEY - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/keies/key/{key-number}/

Delete operation of resource: key

key-number: string
in path

ID of key-number

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

KEY - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/keies/key/{key-number}/

Retrieve operation of resource: key

key-number: string
in path

ID of key-number

200 OK
key_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "key-number": "string",
  "authentication-key": "string"
}

TRUSTED-KEIES - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/trusted-keies/

Update operation of resource: trusted-keies

trusted-keies_schema

trusted-keiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "key-number": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRUSTED-KEIES - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/trusted-keies/

Create operation of resource: trusted-keies

trusted-keies_schema

trusted-keiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "key-number": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRUSTED-KEIES - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/trusted-keies/

Delete operation of resource: trusted-keies

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRUSTED-KEIES - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/trusted-keies/

Retrieve operation of resource: trusted-keies

200 OK
trusted-keies_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "key-number": "string"
    }
  ]
}

TRUSTED-KEY - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/trusted-keies/trusted-key/{key-number}/

Update operation of resource: trusted-key

trusted-key_schema

trusted-keybody object

key-number: string
in path

ID of key-number

Request Content-Types: application/json
Request Example
{
  "key-number": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRUSTED-KEY - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/trusted-keies/trusted-key/{key-number}/

Create operation of resource: trusted-key

trusted-key_schema

trusted-keybody object

key-number: string
in path

ID of key-number

Request Content-Types: application/json
Request Example
{
  "key-number": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRUSTED-KEY - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/trusted-keies/trusted-key/{key-number}/

Delete operation of resource: trusted-key

key-number: string
in path

ID of key-number

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRUSTED-KEY - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/authentication/trusted-keies/trusted-key/{key-number}/

Retrieve operation of resource: trusted-key

key-number: string
in path

ID of key-number

200 OK
trusted-key_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "key-number": "string"
}

PASSIVE - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/passive/

Update operation of resource: passive

passive_schema

passivebody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSIVE - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/passive/

Create operation of resource: passive

passive_schema

passivebody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSIVE - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/passive/

Delete operation of resource: passive

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PASSIVE - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/passive/

Retrieve operation of resource: passive

200 OK
passive_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ]
}

INTERFACE-TABLES - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/

Update operation of resource: interface-tables

interface-tables_schema

interface-tablesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface": "string",
          "disable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            "broadcast-client": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "broadcast-type": "string",
                  "ntp-version": "string",
                  "authentication-key": "string",
                  "address": "string"
                }
              ]
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "ip-address": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "version": "string",
                  "authentication-key": "string",
                  "ip-address": "string",
                  "ttl": "string"
                }
              ]
            }
          }
        }
      ],
      "vrf-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-TABLES - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/

Create operation of resource: interface-tables

interface-tables_schema

interface-tablesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface": "string",
          "disable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            "broadcast-client": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "broadcast-type": "string",
                  "ntp-version": "string",
                  "authentication-key": "string",
                  "address": "string"
                }
              ]
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "ip-address": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "version": "string",
                  "authentication-key": "string",
                  "ip-address": "string",
                  "ttl": "string"
                }
              ]
            }
          }
        }
      ],
      "vrf-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-TABLES - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/

Delete operation of resource: interface-tables

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-TABLES - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/

Retrieve operation of resource: interface-tables

200 OK
interface-tables_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "interface": "string",
          "disable": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            "broadcast-client": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "broadcast-type": "string",
                  "ntp-version": "string",
                  "authentication-key": "string",
                  "address": "string"
                }
              ]
            }
          },
          : { 
PUT            POST           DELETE          GET          
          
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "ip-address": "string"
                }
              ]
            },
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "version": "string",
                  "authentication-key": "string",
                  "ip-address": "string",
                  "ttl": "string"
                }
              ]
            }
          }
        }
      ],
      "vrf-name": "string"
    }
  ]
}

INTERFACE-TABLE - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/

Update operation of resource: interface-table

interface-table_schema

interface-tablebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "interface": "string",
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "broadcast-client": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "broadcast-type": "string",
              "ntp-version": "string",
              "authentication-key": "string",
              "address": "string"
            }
          ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "ip-address": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "version": "string",
              "authentication-key": "string",
              "ip-address": "string",
              "ttl": "string"
            }
          ]
        }
      }
    }
  ],
  "vrf-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-TABLE - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/

Create operation of resource: interface-table

interface-table_schema

interface-tablebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "interface": "string",
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "broadcast-client": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "broadcast-type": "string",
              "ntp-version": "string",
              "authentication-key": "string",
              "address": "string"
            }
          ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "ip-address": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "version": "string",
              "authentication-key": "string",
              "ip-address": "string",
              "ttl": "string"
            }
          ]
        }
      }
    }
  ],
  "vrf-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-TABLE - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/

Delete operation of resource: interface-table

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-TABLE - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/

Retrieve operation of resource: interface-table

vrf-name: string
in path

ID of vrf-name

200 OK
interface-table_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "interface": "string",
      "disable": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        "broadcast-client": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "broadcast-type": "string",
              "ntp-version": "string",
              "authentication-key": "string",
              "address": "string"
            }
          ]
        }
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "ip-address": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "version": "string",
              "authentication-key": "string",
              "ip-address": "string",
              "ttl": "string"
            }
          ]
        }
      }
    }
  ],
  "vrf-name": "string"
}

INTERFACE - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/

Update operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  "interface": "string",
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "broadcast-client": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "broadcast-type": "string",
          "ntp-version": "string",
          "authentication-key": "string",
          "address": "string"
        }
      ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "ip-address": "string"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "version": "string",
          "authentication-key": "string",
          "ip-address": "string",
          "ttl": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/

Create operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  "interface": "string",
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "broadcast-client": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "broadcast-type": "string",
          "ntp-version": "string",
          "authentication-key": "string",
          "address": "string"
        }
      ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "ip-address": "string"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "version": "string",
          "authentication-key": "string",
          "ip-address": "string",
          "ttl": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/

Delete operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/

Retrieve operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "interface": "string",
  "disable": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    "broadcast-client": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "broadcast-type": "string",
          "ntp-version": "string",
          "authentication-key": "string",
          "address": "string"
        }
      ]
    }
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "ip-address": "string"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "version": "string",
          "authentication-key": "string",
          "ip-address": "string",
          "ttl": "string"
        }
      ]
    }
  }
}

INTERFACE-MULTICAST - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/

Update operation of resource: interface-multicast

interface-multicast_schema

interface-multicastbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "version": "string",
        "authentication-key": "string",
        "ip-address": "string",
        "ttl": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-MULTICAST - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/

Create operation of resource: interface-multicast

interface-multicast_schema

interface-multicastbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "version": "string",
        "authentication-key": "string",
        "ip-address": "string",
        "ttl": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-MULTICAST - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/

Delete operation of resource: interface-multicast

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-MULTICAST - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/

Retrieve operation of resource: interface-multicast

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK
interface-multicast_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "version": "string",
        "authentication-key": "string",
        "ip-address": "string",
        "ttl": "string"
      }
    ]
  }
}

MULTICAST-CLIENTS - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-clients/

Update operation of resource: multicast-clients

multicast-clients_schema

multicast-clientsbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-CLIENTS - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-clients/

Create operation of resource: multicast-clients

multicast-clients_schema

multicast-clientsbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-CLIENTS - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-clients/

Delete operation of resource: multicast-clients

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-CLIENTS - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-clients/

Retrieve operation of resource: multicast-clients

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK
multicast-clients_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}

MULTICAST-CLIENT - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-clients/multicast-client/{ip-address}/

Update operation of resource: multicast-client

multicast-client_schema

multicast-clientbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-CLIENT - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-clients/multicast-client/{ip-address}/

Create operation of resource: multicast-client

multicast-client_schema

multicast-clientbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-CLIENT - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-clients/multicast-client/{ip-address}/

Delete operation of resource: multicast-client

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-CLIENT - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-clients/multicast-client/{ip-address}/

Retrieve operation of resource: multicast-client

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

ip-address: string
in path

ID of ip-address

200 OK
multicast-client_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ip-address": "string"
}

MULTICAST-SERVERS - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-servers/

Update operation of resource: multicast-servers

multicast-servers_schema

multicast-serversbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "version": "string",
      "authentication-key": "string",
      "ip-address": "string",
      "ttl": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-SERVERS - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-servers/

Create operation of resource: multicast-servers

multicast-servers_schema

multicast-serversbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "version": "string",
      "authentication-key": "string",
      "ip-address": "string",
      "ttl": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-SERVERS - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-servers/

Delete operation of resource: multicast-servers

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-SERVERS - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-servers/

Retrieve operation of resource: multicast-servers

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK
multicast-servers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "version": "string",
      "authentication-key": "string",
      "ip-address": "string",
      "ttl": "string"
    }
  ]
}

MULTICAST-SERVER - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-servers/multicast-server/{ip-address}/

Update operation of resource: multicast-server

multicast-server_schema

multicast-serverbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "version": "string",
  "authentication-key": "string",
  "ip-address": "string",
  "ttl": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-SERVER - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-servers/multicast-server/{ip-address}/

Create operation of resource: multicast-server

multicast-server_schema

multicast-serverbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "version": "string",
  "authentication-key": "string",
  "ip-address": "string",
  "ttl": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-SERVER - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-servers/multicast-server/{ip-address}/

Delete operation of resource: multicast-server

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTICAST-SERVER - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-multicast/multicast-servers/multicast-server/{ip-address}/

Retrieve operation of resource: multicast-server

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

ip-address: string
in path

ID of ip-address

200 OK
multicast-server_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "version": "string",
  "authentication-key": "string",
  "ip-address": "string",
  "ttl": "string"
}

INTERFACE-BROADCAST - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/

Update operation of resource: interface-broadcast

interface-broadcast_schema

interface-broadcastbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  "broadcast-client": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "broadcast-type": "string",
        "ntp-version": "string",
        "authentication-key": "string",
        "address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-BROADCAST - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/

Create operation of resource: interface-broadcast

interface-broadcast_schema

interface-broadcastbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  "broadcast-client": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "broadcast-type": "string",
        "ntp-version": "string",
        "authentication-key": "string",
        "address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-BROADCAST - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/

Delete operation of resource: interface-broadcast

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE-BROADCAST - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/

Retrieve operation of resource: interface-broadcast

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK
interface-broadcast_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "broadcast-client": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "broadcast-type": "string",
        "ntp-version": "string",
        "authentication-key": "string",
        "address": "string"
      }
    ]
  }
}

BROADCAST-SERVERS - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/broadcast-servers/

Update operation of resource: broadcast-servers

broadcast-servers_schema

broadcast-serversbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "broadcast-type": "string",
      "ntp-version": "string",
      "authentication-key": "string",
      "address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-SERVERS - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/broadcast-servers/

Create operation of resource: broadcast-servers

broadcast-servers_schema

broadcast-serversbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "broadcast-type": "string",
      "ntp-version": "string",
      "authentication-key": "string",
      "address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-SERVERS - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/broadcast-servers/

Delete operation of resource: broadcast-servers

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-SERVERS - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/broadcast-servers/

Retrieve operation of resource: broadcast-servers

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

200 OK
broadcast-servers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "broadcast-type": "string",
      "ntp-version": "string",
      "authentication-key": "string",
      "address": "string"
    }
  ]
}

BROADCAST-SERVER - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/broadcast-servers/broadcast-server/{broadcast-type}/

Update operation of resource: broadcast-server

broadcast-server_schema

broadcast-serverbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

broadcast-type: string
in path

ID of broadcast-type

Request Content-Types: application/json
Request Example
{
  "broadcast-type": "string",
  "ntp-version": "string",
  "authentication-key": "string",
  "address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-SERVER - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/broadcast-servers/broadcast-server/{broadcast-type}/

Create operation of resource: broadcast-server

broadcast-server_schema

broadcast-serverbody object

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

broadcast-type: string
in path

ID of broadcast-type

Request Content-Types: application/json
Request Example
{
  "broadcast-type": "string",
  "ntp-version": "string",
  "authentication-key": "string",
  "address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-SERVER - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/broadcast-servers/broadcast-server/{broadcast-type}/

Delete operation of resource: broadcast-server

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

broadcast-type: string
in path

ID of broadcast-type

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-SERVER - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/interface-tables/interface-table/{vrf-name}/interface/{interface}/interface-broadcast/broadcast-servers/broadcast-server/{broadcast-type}/

Retrieve operation of resource: broadcast-server

vrf-name: string
in path

ID of vrf-name

interface: string
in path

ID of interface

broadcast-type: string
in path

ID of broadcast-type

200 OK
broadcast-server_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "broadcast-type": "string",
  "ntp-version": "string",
  "authentication-key": "string",
  "address": "string"
}

ACCESS-GROUP-TABLES - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/

Update operation of resource: access-group-tables

access-group-tables_schema

access-group-tablesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "access-group-type": "string",
              "access-list-name": "string"
            }
          ],
          "af": "string"
        }
      ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-TABLES - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/

Create operation of resource: access-group-tables

access-group-tables_schema

access-group-tablesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "access-group-type": "string",
              "access-list-name": "string"
            }
          ],
          "af": "string"
        }
      ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-TABLES - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/

Delete operation of resource: access-group-tables

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-TABLES - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/

Retrieve operation of resource: access-group-tables

200 OK
access-group-tables_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "vrf-name": "string",
      : [ 
PUT        POST       DELETE      GET      
      
        {
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "access-group-type": "string",
              "access-list-name": "string"
            }
          ],
          "af": "string"
        }
      ]
    }
  ]
}

ACCESS-GROUP-TABLE - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/

Update operation of resource: access-group-table

access-group-table_schema

access-group-tablebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "access-group-type": "string",
          "access-list-name": "string"
        }
      ],
      "af": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-TABLE - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/

Create operation of resource: access-group-table

access-group-table_schema

access-group-tablebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "access-group-type": "string",
          "access-list-name": "string"
        }
      ],
      "af": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-TABLE - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/

Delete operation of resource: access-group-table

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-TABLE - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/

Retrieve operation of resource: access-group-table

vrf-name: string
in path

ID of vrf-name

200 OK
access-group-table_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "vrf-name": "string",
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "access-group-type": "string",
          "access-list-name": "string"
        }
      ],
      "af": "string"
    }
  ]
}

ACCESS-GROUP-AF-TABLE - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/access-group-af-table/{af}/

Update operation of resource: access-group-af-table

access-group-af-table_schema

access-group-af-tablebody object

vrf-name: string
in path

ID of vrf-name

af: string
in path

ID of af

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "access-group-type": "string",
      "access-list-name": "string"
    }
  ],
  "af": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-AF-TABLE - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/access-group-af-table/{af}/

Create operation of resource: access-group-af-table

access-group-af-table_schema

access-group-af-tablebody object

vrf-name: string
in path

ID of vrf-name

af: string
in path

ID of af

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "access-group-type": "string",
      "access-list-name": "string"
    }
  ],
  "af": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-AF-TABLE - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/access-group-af-table/{af}/

Delete operation of resource: access-group-af-table

vrf-name: string
in path

ID of vrf-name

af: string
in path

ID of af

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP-AF-TABLE - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/access-group-af-table/{af}/

Retrieve operation of resource: access-group-af-table

vrf-name: string
in path

ID of vrf-name

af: string
in path

ID of af

200 OK
access-group-af-table_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "access-group-type": "string",
      "access-list-name": "string"
    }
  ],
  "af": "string"
}

ACCESS-GROUP - Update

PUT Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/access-group-af-table/{af}/access-group/{access-group-type}/

Update operation of resource: access-group

access-group_schema

access-groupbody object

vrf-name: string
in path

ID of vrf-name

af: string
in path

ID of af

access-group-type: string
in path

ID of access-group-type

Request Content-Types: application/json
Request Example
{
  "access-group-type": "string",
  "access-list-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP - Create

POST Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/access-group-af-table/{af}/access-group/{access-group-type}/

Create operation of resource: access-group

access-group_schema

access-groupbody object

vrf-name: string
in path

ID of vrf-name

af: string
in path

ID of af

access-group-type: string
in path

ID of access-group-type

Request Content-Types: application/json
Request Example
{
  "access-group-type": "string",
  "access-list-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP - Delete

DELETE Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/access-group-af-table/{af}/access-group/{access-group-type}/

Delete operation of resource: access-group

vrf-name: string
in path

ID of vrf-name

af: string
in path

ID of af

access-group-type: string
in path

ID of access-group-type

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCESS-GROUP - Retrieve

GET Cisco-IOS-XR-ip-ntp-cfg:ntp/access-group-tables/access-group-table/{vrf-name}/access-group-af-table/{af}/access-group/{access-group-type}/

Retrieve operation of resource: access-group

vrf-name: string
in path

ID of vrf-name

af: string
in path

ID of af

access-group-type: string
in path

ID of access-group-type

200 OK
access-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "access-group-type": "string",
  "access-list-name": "string"
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/

Update operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/

Create operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/

Retrieve operation of resource: snmp

200 OK
a1_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

ENCRYPTED-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Update operation of resource: encrypted-community-maps

a1_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Create operation of resource: encrypted-community-maps

a1_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Delete operation of resource: encrypted-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Retrieve operation of resource: encrypted-community-maps

200 OK
a1_encrypted-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Update operation of resource: encrypted-community-map

a1_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Create operation of resource: encrypted-community-map

a1_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Delete operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Retrieve operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

VIEWS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Update operation of resource: views

a1_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Create operation of resource: views

a1_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Delete operation of resource: views

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Retrieve operation of resource: views

200 OK
a1_views_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

VIEW - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Update operation of resource: view

a1_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Create operation of resource: view

a1_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Delete operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Retrieve operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK
a1_view_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

LOGGING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Update operation of resource: logging

a1_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Create operation of resource: logging

a1_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Retrieve operation of resource: logging

200 OK
a1_logging_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Update operation of resource: threshold

a1_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Create operation of resource: threshold

a1_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Delete operation of resource: threshold

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Retrieve operation of resource: threshold

200 OK
a1_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

ADMINISTRATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Update operation of resource: administration

a1_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Create operation of resource: administration

a1_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Delete operation of resource: administration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Retrieve operation of resource: administration

200 OK
a1_administration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

DEFAULT-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Update operation of resource: default-communities

a1_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Create operation of resource: default-communities

a1_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Delete operation of resource: default-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Retrieve operation of resource: default-communities

200 OK
a1_default-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Update operation of resource: default-community

a1_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Create operation of resource: default-community

a1_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Delete operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Retrieve operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK
a1_default-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

ENCRYPTED-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Update operation of resource: encrypted-communities

a1_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Create operation of resource: encrypted-communities

a1_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Delete operation of resource: encrypted-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Retrieve operation of resource: encrypted-communities

200 OK
a1_encrypted-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Update operation of resource: encrypted-community

a1_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Create operation of resource: encrypted-community

a1_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Delete operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Retrieve operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

AGENT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Update operation of resource: agent

a1_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Create operation of resource: agent

a1_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Delete operation of resource: agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Retrieve operation of resource: agent

200 OK
a1_agent_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

ENGINE-ID - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Update operation of resource: engine-id

a1_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Create operation of resource: engine-id

a1_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Delete operation of resource: engine-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Retrieve operation of resource: engine-id

200 OK
a1_engine-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

REMOTES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Update operation of resource: remotes

a1_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Create operation of resource: remotes

a1_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Delete operation of resource: remotes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Retrieve operation of resource: remotes

200 OK
a1_remotes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

REMOTE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Update operation of resource: remote

a1_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Create operation of resource: remote

a1_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Delete operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Retrieve operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK
a1_remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

TRAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Update operation of resource: trap

a1_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Create operation of resource: trap

a1_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Delete operation of resource: trap

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Retrieve operation of resource: trap

200 OK
a1_trap_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

DROP-PACKET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Update operation of resource: drop-packet

a1_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  "unknown-user": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Create operation of resource: drop-packet

a1_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  "unknown-user": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Delete operation of resource: drop-packet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Retrieve operation of resource: drop-packet

200 OK
a1_drop-packet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "unknown-user": [ null ]
}

IPV6 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Update operation of resource: ipv6

a1_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Create operation of resource: ipv6

a1_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Retrieve operation of resource: ipv6

200 OK
a1_ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Update operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Create operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Retrieve operation of resource: tos

200 OK
a1_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

IPV4 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Update operation of resource: ipv4

a1_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Create operation of resource: ipv4

a1_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Retrieve operation of resource: ipv4

200 OK
a1_ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Update operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Create operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Retrieve operation of resource: tos

200 OK
a1_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

SYSTEM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Update operation of resource: system

a1_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Create operation of resource: system

a1_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Delete operation of resource: system

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Retrieve operation of resource: system

200 OK
a1_system_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Update operation of resource: target

a1_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Create operation of resource: target

a1_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Delete operation of resource: target

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Retrieve operation of resource: target

200 OK
a1_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

TARGETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Update operation of resource: targets

a1_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Create operation of resource: targets

a1_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Delete operation of resource: targets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Retrieve operation of resource: targets

200 OK
a1_targets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Update operation of resource: target

a1_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Create operation of resource: target

a1_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Delete operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Retrieve operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK
a1_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string"
      }
    ]
  }
}

VRF-NAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Update operation of resource: vrf-names

a1_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Create operation of resource: vrf-names

a1_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Delete operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Retrieve operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK
a1_vrf-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string"
    }
  ]
}

VRF-NAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Update operation of resource: vrf-name

a1_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Create operation of resource: vrf-name

a1_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Delete operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Retrieve operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK
a1_vrf-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string"
}

TARGET-ADDRESSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Update operation of resource: target-addresses

a1_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Create operation of resource: target-addresses

a1_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Delete operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Retrieve operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK
a1_target-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "ip-address": "string"
    }
  ]
}

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Update operation of resource: target-address

a1_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Create operation of resource: target-address

a1_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Delete operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Retrieve operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK
a1_target-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "ip-address": "string"
}

NOTIFICATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Update operation of resource: notification

a1_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Create operation of resource: notification

a1_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Delete operation of resource: notification

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Retrieve operation of resource: notification

200 OK
a1_notification_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    "enable": [ null ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Update operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Create operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Retrieve operation of resource: snmp

200 OK
a1_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

NTP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/ntp/

Update operation of resource: ntp

a1_ntp_schema

ntpbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NTP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/ntp/

Create operation of resource: ntp

a1_ntp_schema

ntpbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NTP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/ntp/

Delete operation of resource: ntp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NTP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/ntp/

Retrieve operation of resource: ntp

200 OK
a1_ntp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "enable": [ null ]
}

CORRELATOR - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Update operation of resource: correlator

a1_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Create operation of resource: correlator

a1_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Delete operation of resource: correlator

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Retrieve operation of resource: correlator

200 OK
a1_correlator_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              "created": [ null ],
              : { 
PUT                POST               DELETE              GET              
              
                : [ 
PUT                  POST                 DELETE                GET                
                
                  {
                    "oid": "string",
                    : { 
PUT                      POST                     DELETE                    GET                    
                    
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "rulename": "string"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          "all": [ null ],
          : { 
PUT            POST           DELETE          GET          
          
            : [ 
PUT              POST             DELETE            GET            
            
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

RULES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Update operation of resource: rules

a1_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Create operation of resource: rules

a1_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Delete operation of resource: rules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Retrieve operation of resource: rules

200 OK
a1_rules_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            "created": [ null ],
            : { 
PUT              POST             DELETE            GET            
            
              : [ 
PUT                POST               DELETE              GET              
              
                {
                  "oid": "string",
                  : { 
PUT                    POST                   DELETE                  GET                  
                  
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Update operation of resource: rule

a1_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Create operation of resource: rule

a1_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Delete operation of resource: rule

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Retrieve operation of resource: rule

name: string
in path

ID of name

200 OK
a1_rule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        "created": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string",
              : { 
PUT                POST               DELETE              GET              
              
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Update operation of resource: root-causes

a1_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Create operation of resource: root-causes

a1_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Delete operation of resource: root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Retrieve operation of resource: root-causes

name: string
in path

ID of name

200 OK
a1_root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Update operation of resource: root-cause

a1_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Create operation of resource: root-cause

a1_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Delete operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Retrieve operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "index": "string",
  "value": "string"
}

NON-ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Update operation of resource: non-root-causes

a1_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Create operation of resource: non-root-causes

a1_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Delete operation of resource: non-root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Retrieve operation of resource: non-root-causes

name: string
in path

ID of name

200 OK
a1_non-root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      "created": [ null ],
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "oid": "string",
            : { 
PUT              POST             DELETE            GET            
            
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

NON-ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Update operation of resource: non-root-cause

a1_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Create operation of resource: non-root-cause

a1_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Delete operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Retrieve operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_non-root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  "created": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "oid": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "index": "string",
  "value": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Update operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Create operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a1_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Update operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Create operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a1_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a1_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "ip-address": "string"
}

RULE-SETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Update operation of resource: rule-sets

a1_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Create operation of resource: rule-sets

a1_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Delete operation of resource: rule-sets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Retrieve operation of resource: rule-sets

200 OK
a1_rule-sets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "rulename": "string"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        "all": [ null ],
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE-SET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Update operation of resource: rule-set

a1_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Create operation of resource: rule-set

a1_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Delete operation of resource: rule-set

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Retrieve operation of resource: rule-set

name: string
in path

ID of name

200 OK
a1_rule-set_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "rulename": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    "all": [ null ],
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

RULENAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Update operation of resource: rulenames

a1_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Create operation of resource: rulenames

a1_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Delete operation of resource: rulenames

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Retrieve operation of resource: rulenames

name: string
in path

ID of name

200 OK
a1_rulenames_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "rulename": "string"
    }
  ]
}

RULENAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Update operation of resource: rulename

a1_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  "rulename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Create operation of resource: rulename

a1_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  "rulename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Delete operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Retrieve operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK
a1_rulename_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "rulename": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Update operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Create operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a1_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "all": [ null ],
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Update operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Create operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a1_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a1_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "ip-address": "string"
}

BULK-STATS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Update operation of resource: bulk-stats

a1_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Create operation of resource: bulk-stats

a1_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Delete operation of resource: bulk-stats

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Retrieve operation of resource: bulk-stats

200 OK
a1_bulk-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "memory": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "retry": "integer",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "object-list-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string",
        : { 
PUT          POST         DELETE        GET        
        
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Update operation of resource: schemas

a1_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Create operation of resource: schemas

a1_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Delete operation of resource: schemas

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Retrieve operation of resource: schemas

200 OK
a1_schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Update operation of resource: schema

a1_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Create operation of resource: schema

a1_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Delete operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Retrieve operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK
a1_schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "schema-name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

INSTANCE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Update operation of resource: instance

a1_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Create operation of resource: instance

a1_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Delete operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Retrieve operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK
a1_instance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Update operation of resource: objects

a1_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Create operation of resource: objects

a1_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Delete operation of resource: objects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Retrieve operation of resource: objects

200 OK
a1_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Update operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Create operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK
a1_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Update operation of resource: objects

a1_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Create operation of resource: objects

a1_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Delete operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Retrieve operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK
a1_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Update operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Create operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK
a1_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "oid": "string"
}

TRANSFERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Update operation of resource: transfers

a1_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Create operation of resource: transfers

a1_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Delete operation of resource: transfers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Retrieve operation of resource: transfers

200 OK
a1_transfers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "retry": "integer",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

TRANSFER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Update operation of resource: transfer

a1_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Create operation of resource: transfer

a1_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Delete operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Retrieve operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK
a1_transfer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "retry": "integer",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

TRANSFER-SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Update operation of resource: transfer-schemas

a1_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Create operation of resource: transfer-schemas

a1_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Delete operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Retrieve operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK
a1_transfer-schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "schema-name": "string"
    }
  ]
}

TRANSFER-SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Update operation of resource: transfer-schema

a1_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Create operation of resource: transfer-schema

a1_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Delete operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Retrieve operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK
a1_transfer-schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "schema-name": "string"
}

DEFAULT-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Update operation of resource: default-community-maps

a1_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Create operation of resource: default-community-maps

a1_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Delete operation of resource: default-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Retrieve operation of resource: default-community-maps

200 OK
a1_default-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Update operation of resource: default-community-map

a1_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Create operation of resource: default-community-map

a1_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Delete operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Retrieve operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK
a1_default-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

OVERLOAD-CONTROL - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Update operation of resource: overload-control

a1_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Create operation of resource: overload-control

a1_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Delete operation of resource: overload-control

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Retrieve operation of resource: overload-control

200 OK
a1_overload-control_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

TIMEOUTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Update operation of resource: timeouts

a1_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Create operation of resource: timeouts

a1_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Delete operation of resource: timeouts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Retrieve operation of resource: timeouts

200 OK
a1_timeouts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

USERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Update operation of resource: users

a1_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Create operation of resource: users

a1_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Delete operation of resource: users

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Retrieve operation of resource: users

200 OK
a1_users_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

USER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Update operation of resource: user

a1_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Create operation of resource: user

a1_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Delete operation of resource: user

user-name: string
in path

ID of user-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Retrieve operation of resource: user

user-name: string
in path

ID of user-name

200 OK
a1_user_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

VRFS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Update operation of resource: vrfs

a1_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Create operation of resource: vrfs

a1_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Retrieve operation of resource: vrfs

200 OK
a1_vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Update operation of resource: vrf

a1_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Create operation of resource: vrf

a1_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Delete operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Retrieve operation of resource: vrf

name: string
in path

ID of name

200 OK
a1_vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Update operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Create operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Delete operation of resource: trap-hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Retrieve operation of resource: trap-hosts

name: string
in path

ID of name

200 OK
a1_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Update operation of resource: contexts

a1_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Create operation of resource: contexts

a1_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Delete operation of resource: contexts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Retrieve operation of resource: contexts

name: string
in path

ID of name

200 OK
a1_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Update operation of resource: context

a1_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Create operation of resource: context

a1_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Delete operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Retrieve operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK
a1_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Update operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Create operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Delete operation of resource: context-mappings

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Retrieve operation of resource: context-mappings

name: string
in path

ID of name

200 OK
a1_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a1_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

GROUPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Update operation of resource: groups

a1_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Create operation of resource: groups

a1_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Retrieve operation of resource: groups

200 OK
a1_groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

GROUP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Update operation of resource: group

a1_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Create operation of resource: group

a1_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Delete operation of resource: group

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Retrieve operation of resource: group

name: string
in path

ID of name

200 OK
a1_group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Update operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Create operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Delete operation of resource: trap-hosts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Retrieve operation of resource: trap-hosts

200 OK
a1_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      : { 
PUT        POST       DELETE      GET      
      
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        : { 
PUT          POST         DELETE        GET        
        
          : [ 
PUT            POST           DELETE          GET          
          
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      : { 
PUT        POST       DELETE      GET      
      
        : [ 
PUT          POST         DELETE        GET        
        
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK
a1_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    : { 
PUT      POST     DELETE    GET    
    
      : [ 
PUT        POST       DELETE      GET      
      
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  : { 
PUT    POST   DELETE  GET  
  
    : [ 
PUT      POST     DELETE    GET    
    
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Update operation of resource: contexts

a1_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Create operation of resource: contexts

a1_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Delete operation of resource: contexts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Retrieve operation of resource: contexts

200 OK
a1_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Update operation of resource: context

a1_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Create operation of resource: context

a1_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Delete operation of resource: context

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Retrieve operation of resource: context

context-name: string
in path

ID of context-name

200 OK
a1_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Update operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Create operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Delete operation of resource: context-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Retrieve operation of resource: context-mappings

200 OK
a1_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [ 
PUT    POST   DELETE  GET  
  
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a1_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

MIB - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:mib/

Update operation of resource: mib

a1_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Create

POST Cisco-IOS-XR-snmp-agent-cfg:mib/

Create operation of resource: mib

a1_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:mib/

Delete operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:mib/

Retrieve operation of resource: mib

200 OK
a1_mib_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)

Schema Definitions

ntp_schema:

NTP configuration

peer-vrfs: object

Configures NTP Peers or Servers

peer-vrf: object[]

Configures NTP Peers or Servers for a single VRF. The 'default' must also be specified for default VRF

object
peer-ipv4s: object

Configures IPv4 NTP Peers or Servers

peer-ipv4: object[]

Configure an IPv4 NTP server or peer

object
address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

vrf-name: string

VRF name

peer-ipv6s: object

Configuration NTP Peers or Servers of IPV6

peer-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

access-group-tables: object

Control NTP access

access-group-table: object[]

Control NTP access

object
vrf-name: string

VRF name

access-group-af-table: object[]

Configure NTP access address family

object
access-group: object[]

Configure NTP access group

object
access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

af: string ipv4, ipv6

Address family

admin-types: object

Configure NTP server admin-plane

admin-type: object[]

Configure NTP server admin plane

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

preferred-peer: string

Preferred peer

update-calendar: null

To enable calendar update with NTP time

broadcast-delay: integer

Estimated round-trip delay

range:"1..999999"
log-internal-sync: null

To enable logging internal sync conflicts

max-associations: integer

Set maximum number of associations

range:"0..4294967295"
drift: object

NTP drift

aging-time: integer

Drift Aging Time

range:"0..65535"
file: object

File containing drift value

location: string

disk0 or apphost or config or ftp or harddisk or rootfs or tftp. Defaults to PWD if none specified

filename: string

File containing drift value

interface-tables: object

NTP per interface configuration

interface-table: object[]

NTP per interface configuration

object
interface: object[]

Name of the interface

object
interface: string

interface

disable: null

Disable NTP

interface-broadcast: object

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

interface-multicast: object

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

vrf-name: string

VRF name

passive: object

Configure NTP passive associations

enable: null

Enable NTP Passive associations

sources: object

Configure NTP source interface

source: object[]

Configure NTP source interface

object
source-interface: string

Source Interface for NTP

vrf-name: string

VRF name

authentication: object

Configure NTP Authentication keys

keies: object

Authentication Key Table

key: object[]

Authentication key for trusted time sources

object
key-number: string

Authentication Key number

authentication-key: string

Authentication key - maximum 32 characters

trusted-keies: object

Key numbers for trusted time sources

trusted-key: object[]

Configure NTP trusted key

object
key-number: string

Key number

enable: null

Enable NTP authentication keys

master: integer

Act as NTP master clock

range:"1..15" default:"8"
dscp-ipv6: object

Set IP DSCP value for outgoing NTP IPV6 packets

mode: string ntp-precedence, ntpdscp

NTPPRECEDENCE(0) to specify Precedence value NTPDSCP(1) to specify DSCP value

dscp-or-precedence-value: integer

If Mode is set to 'NTPPRECEDENCE(0)' specify Precedence value , if Mode is set to 'NTPDSCP(1)' specify DSCP

range:"0..63"
dscp-ipv4: object

Set IP DSCP value for outgoing NTP IPV4 packets

mode: string ntp-precedence, ntpdscp

NTPPRECEDENCE (0) to specify Precedence value NTPDSCP (1) to specify DSCP value

dscp-or-precedence-value: integer

If Mode is set to 'NTPPRECEDENCE(0)' specify Precedence value , if Mode is set to 'NTPDSCP(1)' specify DSCP

range:"0..63"
Example
{
  "peer-vrfs": {
    "peer-vrf": [
      {
        "peer-ipv4s": {
          "peer-ipv4": [
            {
              "address-ipv4": "string",
              "peer-type-ipv4": [
                {
                  "authentication-key": "string",
                  "burst": "string",
                  "ntp-version": "string",
                  "min-poll": "integer",
                  "iburst": "string",
                  "max-poll": "integer",
                  "peer-type": "string",
                  "source-interface": "string",
                  "preferred-peer": "string"
                }
              ]
            }
          ]
        },
        "vrf-name": "string",
        "peer-ipv6s": {
          "peer-ipv6": [
            {
              "address-ipv6": "string",
              "peer-type-ipv6": [
                {
                  "address-ipv6": "string",
                  "authentication-key": "string",
                  "burst": "string",
                  "ntp-version": "string",
                  "min-poll": "integer",
                  "iburst": "string",
                  "max-poll": "integer",
                  "peer-type": "string",
                  "source-interface": "string",
                  "preferred-peer": "string"
                }
              ]
            }
          ]
        }
      }
    ]
  },
  "access-group-tables": {
    "access-group-table": [
      {
        "vrf-name": "string",
        "access-group-af-table": [
          {
            "access-group": [
              {
                "access-group-type": "string",
                "access-list-name": "string"
              }
            ],
            "af": "string"
          }
        ]
      }
    ]
  },
  "admin-types": {
    "admin-type": [
      {
        "authentication-key": "string",
        "burst": "string",
        "ntp-version": "string",
        "min-poll": "integer",
        "iburst": "string",
        "max-poll": "integer",
        "peer-type": "string",
        "preferred-peer": "string"
      }
    ]
  },
  "update-calendar": [ null ],
  "broadcast-delay": "integer",
  "log-internal-sync": [ null ],
  "max-associations": "integer",
  "drift": {
    "aging-time": "integer",
    "file": {
      "location": "string",
      "filename": "string"
    }
  },
  "interface-tables": {
    "interface-table": [
      {
        "interface": [
          {
            "interface": "string",
            "disable": [ null ],
            "interface-broadcast": {
              "broadcast-client": [ null ],
              "broadcast-servers": {
                "broadcast-server": [
                  {
                    "broadcast-type": "string",
                    "ntp-version": "string",
                    "authentication-key": "string",
                    "address": "string"
                  }
                ]
              }
            },
            "interface-multicast": {
              "multicast-clients": {
                "multicast-client": [
                  {
                    "ip-address": "string"
                  }
                ]
              },
              "multicast-servers": {
                "multicast-server": [
                  {
                    "version": "string",
                    "authentication-key": "string",
                    "ip-address": "string",
                    "ttl": "string"
                  }
                ]
              }
            }
          }
        ],
        "vrf-name": "string"
      }
    ]
  },
  "passive": {
    "enable": [ null ]
  },
  "sources": {
    "source": [ null ]
  }
}

admin-types_schema:

Configure NTP server admin-plane

admin-type: object[]

Configure NTP server admin plane

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

preferred-peer: string

Preferred peer

Example
{
  "admin-type": [
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "preferred-peer": "string"
    }
  ]
}

admin-type_schema:

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

preferred-peer: string

Preferred peer

Example
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "preferred-peer": "string"
}

peer-vrfs_schema:

Configures NTP Peers or Servers

peer-vrf: object[]

Configures NTP Peers or Servers for a single VRF. The 'default' must also be specified for default VRF

object
peer-ipv4s: object

Configures IPv4 NTP Peers or Servers

peer-ipv4: object[]

Configure an IPv4 NTP server or peer

object
address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

vrf-name: string

VRF name

peer-ipv6s: object

Configuration NTP Peers or Servers of IPV6

peer-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "peer-vrf": [
    {
      "peer-ipv4s": {
        "peer-ipv4": [
          {
            "address-ipv4": "string",
            "peer-type-ipv4": [
              {
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      },
      "vrf-name": "string",
      "peer-ipv6s": {
        "peer-ipv6": [
          {
            "address-ipv6": "string",
            "peer-type-ipv6": [
              {
                "address-ipv6": "string",
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      }
    }
  ]
}

peer-vrf_schema:

peer-ipv4s: object

Configures IPv4 NTP Peers or Servers

peer-ipv4: object[]

Configure an IPv4 NTP server or peer

object
address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

vrf-name: string

VRF name

peer-ipv6s: object

Configuration NTP Peers or Servers of IPV6

peer-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "peer-ipv4s": {
    "peer-ipv4": [
      {
        "address-ipv4": "string",
        "peer-type-ipv4": [
          {
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  },
  "vrf-name": "string",
  "peer-ipv6s": {
    "peer-ipv6": [
      {
        "address-ipv6": "string",
        "peer-type-ipv6": [
          {
            "address-ipv6": "string",
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  }
}

peer-ipv4s_schema:

Configures IPv4 NTP Peers or Servers

peer-ipv4: object[]

Configure an IPv4 NTP server or peer

object
address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "peer-ipv4": [
    {
      "address-ipv4": "string",
      "peer-type-ipv4": [
        {
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}

peer-ipv4_schema:

address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "address-ipv4": "string",
  "peer-type-ipv4": [
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}

peer-type-ipv4_schema:

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}

peer-ipv6s_schema:

Configuration NTP Peers or Servers of IPV6

peer-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "peer-ipv6": [
    {
      "address-ipv6": "string",
      "peer-type-ipv6": [
        {
          "address-ipv6": "string",
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}

peer-ipv6_schema:

address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "address-ipv6": "string",
  "peer-type-ipv6": [
    {
      "address-ipv6": "string",
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}

peer-type-ipv6_schema:

address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "address-ipv6": "string",
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}

dscp-ipv4_schema:

Set IP DSCP value for outgoing NTP IPV4 packets

mode: string ntp-precedence, ntpdscp

NTPPRECEDENCE (0) to specify Precedence value NTPDSCP (1) to specify DSCP value

dscp-or-precedence-value: integer

If Mode is set to 'NTPPRECEDENCE(0)' specify Precedence value , if Mode is set to 'NTPDSCP(1)' specify DSCP

range:"0..63"
Example
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}

dscp-ipv6_schema:

Set IP DSCP value for outgoing NTP IPV6 packets

mode: string ntp-precedence, ntpdscp

NTPPRECEDENCE(0) to specify Precedence value NTPDSCP(1) to specify DSCP value

dscp-or-precedence-value: integer

If Mode is set to 'NTPPRECEDENCE(0)' specify Precedence value , if Mode is set to 'NTPDSCP(1)' specify DSCP

range:"0..63"
Example
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}

sources_schema:

Configure NTP source interface

source: object[]

Configure NTP source interface

object
source-interface: string

Source Interface for NTP

vrf-name: string

VRF name

Example
{
  "source": [
    {
      "source-interface": "string",
      "vrf-name": "string"
    }
  ]
}

source_schema:

source-interface: string

Source Interface for NTP

vrf-name: string

VRF name

Example
{
  "source-interface": "string",
  "vrf-name": "string"
}

drift_schema:

NTP drift

aging-time: integer

Drift Aging Time

range:"0..65535"
file: object

File containing drift value

location: string

disk0 or apphost or config or ftp or harddisk or rootfs or tftp. Defaults to PWD if none specified

filename: string

File containing drift value

Example
{
  "aging-time": "integer",
  "file": {
    "location": "string",
    "filename": "string"
  }
}

file_schema:

File containing drift value

location: string

disk0 or apphost or config or ftp or harddisk or rootfs or tftp. Defaults to PWD if none specified

filename: string

File containing drift value

Example
{
  "location": "string",
  "filename": "string"
}

authentication_schema:

Configure NTP Authentication keys

keies: object

Authentication Key Table

key: object[]

Authentication key for trusted time sources

object
key-number: string

Authentication Key number

authentication-key: string

Authentication key - maximum 32 characters

trusted-keies: object

Key numbers for trusted time sources

trusted-key: object[]

Configure NTP trusted key

object
key-number: string

Key number

enable: null

Enable NTP authentication keys

Example
{
  "keies": {
    "key": [
      {
        "key-number": "string",
        "authentication-key": "string"
      }
    ]
  },
  "trusted-keies": {
    "trusted-key": [
      {
        "key-number": "string"
      }
    ]
  },
  "enable": [ null ]
}

keies_schema:

Authentication Key Table

key: object[]

Authentication key for trusted time sources

object
key-number: string

Authentication Key number

authentication-key: string

Authentication key - maximum 32 characters

Example
{
  "key": [
    {
      "key-number": "string",
      "authentication-key": "string"
    }
  ]
}

key_schema:

key-number: string

Authentication Key number

authentication-key: string

Authentication key - maximum 32 characters

Example
{
  "key-number": "string",
  "authentication-key": "string"
}

trusted-keies_schema:

Key numbers for trusted time sources

trusted-key: object[]

Configure NTP trusted key

object
key-number: string

Key number

Example
{
  "trusted-key": [
    {
      "key-number": "string"
    }
  ]
}

trusted-key_schema:

key-number: string

Key number

Example
{
  "key-number": "string"
}

passive_schema:

Configure NTP passive associations

enable: null

Enable NTP Passive associations

Example
{
  "enable": [ null ]
}

interface-tables_schema:

NTP per interface configuration

interface-table: object[]

NTP per interface configuration

object
interface: object[]

Name of the interface

object
interface: string

interface

disable: null

Disable NTP

interface-broadcast: object

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

interface-multicast: object

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

vrf-name: string

VRF name

Example
{
  "interface-table": [
    {
      "interface": [
        {
          "interface": "string",
          "disable": [ null ],
          "interface-broadcast": {
            "broadcast-client": [ null ],
            "broadcast-servers": {
              "broadcast-server": [
                {
                  "broadcast-type": "string",
                  "ntp-version": "string",
                  "authentication-key": "string",
                  "address": "string"
                }
              ]
            }
          },
          "interface-multicast": {
            "multicast-clients": {
              "multicast-client": [
                {
                  "ip-address": "string"
                }
              ]
            },
            "multicast-servers": {
              "multicast-server": [
                {
                  "version": "string",
                  "authentication-key": "string",
                  "ip-address": "string",
                  "ttl": "string"
                }
              ]
            }
          }
        }
      ],
      "vrf-name": "string"
    }
  ]
}

interface-table_schema:

interface: object[]

Name of the interface

object
interface: string

interface

disable: null

Disable NTP

interface-broadcast: object

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

interface-multicast: object

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

vrf-name: string

VRF name

Example
{
  "interface": [
    {
      "interface": "string",
      "disable": [ null ],
      "interface-broadcast": {
        "broadcast-client": [ null ],
        "broadcast-servers": {
          "broadcast-server": [
            {
              "broadcast-type": "string",
              "ntp-version": "string",
              "authentication-key": "string",
              "address": "string"
            }
          ]
        }
      },
      "interface-multicast": {
        "multicast-clients": {
          "multicast-client": [
            {
              "ip-address": "string"
            }
          ]
        },
        "multicast-servers": {
          "multicast-server": [
            {
              "version": "string",
              "authentication-key": "string",
              "ip-address": "string",
              "ttl": "string"
            }
          ]
        }
      }
    }
  ],
  "vrf-name": "string"
}

interface_schema:

interface: string

interface

disable: null

Disable NTP

interface-broadcast: object

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

interface-multicast: object

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

Example
{
  "interface": "string",
  "disable": [ null ],
  "interface-broadcast": {
    "broadcast-client": [ null ],
    "broadcast-servers": {
      "broadcast-server": [
        {
          "broadcast-type": "string",
          "ntp-version": "string",
          "authentication-key": "string",
          "address": "string"
        }
      ]
    }
  },
  "interface-multicast": {
    "multicast-clients": {
      "multicast-client": [
        {
          "ip-address": "string"
        }
      ]
    },
    "multicast-servers": {
      "multicast-server": [
        {
          "version": "string",
          "authentication-key": "string",
          "ip-address": "string",
          "ttl": "string"
        }
      ]
    }
  }
}

interface-multicast_schema:

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

Example
{
  "multicast-clients": {
    "multicast-client": [
      {
        "ip-address": "string"
      }
    ]
  },
  "multicast-servers": {
    "multicast-server": [
      {
        "version": "string",
        "authentication-key": "string",
        "ip-address": "string",
        "ttl": "string"
      }
    ]
  }
}

multicast-clients_schema:

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

Example
{
  "multicast-client": [
    {
      "ip-address": "string"
    }
  ]
}

multicast-client_schema:

ip-address: string

IP address of a multicast group

Example
{
  "ip-address": "string"
}

multicast-servers_schema:

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

Example
{
  "multicast-server": [
    {
      "version": "string",
      "authentication-key": "string",
      "ip-address": "string",
      "ttl": "string"
    }
  ]
}

multicast-server_schema:

version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

Example
{
  "version": "string",
  "authentication-key": "string",
  "ip-address": "string",
  "ttl": "string"
}

interface-broadcast_schema:

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

Example
{
  "broadcast-client": [ null ],
  "broadcast-servers": {
    "broadcast-server": [
      {
        "broadcast-type": "string",
        "ntp-version": "string",
        "authentication-key": "string",
        "address": "string"
      }
    ]
  }
}

broadcast-servers_schema:

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

Example
{
  "broadcast-server": [
    {
      "broadcast-type": "string",
      "ntp-version": "string",
      "authentication-key": "string",
      "address": "string"
    }
  ]
}

broadcast-server_schema:

broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

Example
{
  "broadcast-type": "string",
  "ntp-version": "string",
  "authentication-key": "string",
  "address": "string"
}

access-group-tables_schema:

Control NTP access

access-group-table: object[]

Control NTP access

object
vrf-name: string

VRF name

access-group-af-table: object[]

Configure NTP access address family

object
access-group: object[]

Configure NTP access group

object
access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

af: string ipv4, ipv6

Address family

Example
{
  "access-group-table": [
    {
      "vrf-name": "string",
      "access-group-af-table": [
        {
          "access-group": [
            {
              "access-group-type": "string",
              "access-list-name": "string"
            }
          ],
          "af": "string"
        }
      ]
    }
  ]
}

access-group-table_schema:

vrf-name: string

VRF name

access-group-af-table: object[]

Configure NTP access address family

object
access-group: object[]

Configure NTP access group

object
access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

af: string ipv4, ipv6

Address family

Example
{
  "vrf-name": "string",
  "access-group-af-table": [
    {
      "access-group": [
        {
          "access-group-type": "string",
          "access-list-name": "string"
        }
      ],
      "af": "string"
    }
  ]
}

access-group-af-table_schema:

access-group: object[]

Configure NTP access group

object
access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

af: string ipv4, ipv6

Address family

Example
{
  "access-group": [
    {
      "access-group-type": "string",
      "access-list-name": "string"
    }
  ],
  "af": "string"
}

access-group_schema:

access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

Example
{
  "access-group-type": "string",
  "access-list-name": "string"
}

a1_ntp_schema:

CISCO-NTP-MIB notification configuration

enable: null

Enable ciscoNtpMIB notification configuration

Example
{
  "enable": [ null ]
}

a1_admin-types_schema:

Configure NTP server admin-plane

admin-type: object[]

Configure NTP server admin plane

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

preferred-peer: string

Preferred peer

Example
{
  "admin-type": [
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "preferred-peer": "string"
    }
  ]
}

a1_admin-type_schema:

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

preferred-peer: string

Preferred peer

Example
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "preferred-peer": "string"
}

a1_peer-vrfs_schema:

Configures NTP Peers or Servers

peer-vrf: object[]

Configures NTP Peers or Servers for a single VRF. The 'default' must also be specified for default VRF

object
peer-ipv4s: object

Configures IPv4 NTP Peers or Servers

peer-ipv4: object[]

Configure an IPv4 NTP server or peer

object
address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

vrf-name: string

VRF name

peer-ipv6s: object

Configuration NTP Peers or Servers of IPV6

peer-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "peer-vrf": [
    {
      "peer-ipv4s": {
        "peer-ipv4": [
          {
            "address-ipv4": "string",
            "peer-type-ipv4": [
              {
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      },
      "vrf-name": "string",
      "peer-ipv6s": {
        "peer-ipv6": [
          {
            "address-ipv6": "string",
            "peer-type-ipv6": [
              {
                "address-ipv6": "string",
                "authentication-key": "string",
                "burst": "string",
                "ntp-version": "string",
                "min-poll": "integer",
                "iburst": "string",
                "max-poll": "integer",
                "peer-type": "string",
                "source-interface": "string",
                "preferred-peer": "string"
              }
            ]
          }
        ]
      }
    }
  ]
}

a1_peer-vrf_schema:

peer-ipv4s: object

Configures IPv4 NTP Peers or Servers

peer-ipv4: object[]

Configure an IPv4 NTP server or peer

object
address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

vrf-name: string

VRF name

peer-ipv6s: object

Configuration NTP Peers or Servers of IPV6

peer-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "peer-ipv4s": {
    "peer-ipv4": [
      {
        "address-ipv4": "string",
        "peer-type-ipv4": [
          {
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  },
  "vrf-name": "string",
  "peer-ipv6s": {
    "peer-ipv6": [
      {
        "address-ipv6": "string",
        "peer-type-ipv6": [
          {
            "address-ipv6": "string",
            "authentication-key": "string",
            "burst": "string",
            "ntp-version": "string",
            "min-poll": "integer",
            "iburst": "string",
            "max-poll": "integer",
            "peer-type": "string",
            "source-interface": "string",
            "preferred-peer": "string"
          }
        ]
      }
    ]
  }
}

a1_peer-ipv4s_schema:

Configures IPv4 NTP Peers or Servers

peer-ipv4: object[]

Configure an IPv4 NTP server or peer

object
address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "peer-ipv4": [
    {
      "address-ipv4": "string",
      "peer-type-ipv4": [
        {
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}

a1_peer-ipv4_schema:

address-ipv4: string

IPv4 Address of a peer

peer-type-ipv4: object[]

Configure an IPv4 NTP server or peer

object
authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "address-ipv4": "string",
  "peer-type-ipv4": [
    {
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}

a1_peer-type-ipv4_schema:

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}

a1_peer-ipv6s_schema:

Configuration NTP Peers or Servers of IPV6

peer-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "peer-ipv6": [
    {
      "address-ipv6": "string",
      "peer-type-ipv6": [
        {
          "address-ipv6": "string",
          "authentication-key": "string",
          "burst": "string",
          "ntp-version": "string",
          "min-poll": "integer",
          "iburst": "string",
          "max-poll": "integer",
          "peer-type": "string",
          "source-interface": "string",
          "preferred-peer": "string"
        }
      ]
    }
  ]
}

a1_peer-ipv6_schema:

address-ipv6: string

Address of a peer

peer-type-ipv6: object[]

Configure a NTP server or peer

object
address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "address-ipv6": "string",
  "peer-type-ipv6": [
    {
      "address-ipv6": "string",
      "authentication-key": "string",
      "burst": "string",
      "ntp-version": "string",
      "min-poll": "integer",
      "iburst": "string",
      "max-poll": "integer",
      "peer-type": "string",
      "source-interface": "string",
      "preferred-peer": "string"
    }
  ]
}

a1_peer-type-ipv6_schema:

address-ipv6: string

IPv6 address

authentication-key: string

Authentication Key

burst: string

Use burst mode

ntp-version: string

NTP version

min-poll: integer

Minimum poll interval

range:"4..17"
iburst: string

Use iburst mode

max-poll: integer

Maxinum poll interval

range:"4..17"
peer-type: string peer, server

Peer or Server

source-interface: string

Source interface of this peer

preferred-peer: string

Preferred peer

Example
{
  "address-ipv6": "string",
  "authentication-key": "string",
  "burst": "string",
  "ntp-version": "string",
  "min-poll": "integer",
  "iburst": "string",
  "max-poll": "integer",
  "peer-type": "string",
  "source-interface": "string",
  "preferred-peer": "string"
}

a1_dscp-ipv4_schema:

Set IP DSCP value for outgoing NTP IPV4 packets

mode: string ntp-precedence, ntpdscp

NTPPRECEDENCE (0) to specify Precedence value NTPDSCP (1) to specify DSCP value

dscp-or-precedence-value: integer

If Mode is set to 'NTPPRECEDENCE(0)' specify Precedence value , if Mode is set to 'NTPDSCP(1)' specify DSCP

range:"0..63"
Example
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}

a1_dscp-ipv6_schema:

Set IP DSCP value for outgoing NTP IPV6 packets

mode: string ntp-precedence, ntpdscp

NTPPRECEDENCE(0) to specify Precedence value NTPDSCP(1) to specify DSCP value

dscp-or-precedence-value: integer

If Mode is set to 'NTPPRECEDENCE(0)' specify Precedence value , if Mode is set to 'NTPDSCP(1)' specify DSCP

range:"0..63"
Example
{
  "mode": "string",
  "dscp-or-precedence-value": "integer"
}

a1_sources_schema:

Configure NTP source interface

source: object[]

Configure NTP source interface

object
source-interface: string

Source Interface for NTP

vrf-name: string

VRF name

Example
{
  "source": [
    {
      "source-interface": "string",
      "vrf-name": "string"
    }
  ]
}

a1_source_schema:

source-interface: string

Source Interface for NTP

vrf-name: string

VRF name

Example
{
  "source-interface": "string",
  "vrf-name": "string"
}

a1_drift_schema:

NTP drift

aging-time: integer

Drift Aging Time

range:"0..65535"
file: object

File containing drift value

location: string

disk0 or apphost or config or ftp or harddisk or rootfs or tftp. Defaults to PWD if none specified

filename: string

File containing drift value

Example
{
  "aging-time": "integer",
  "file": {
    "location": "string",
    "filename": "string"
  }
}

a1_file_schema:

File containing drift value

location: string

disk0 or apphost or config or ftp or harddisk or rootfs or tftp. Defaults to PWD if none specified

filename: string

File containing drift value

Example
{
  "location": "string",
  "filename": "string"
}

a1_authentication_schema:

Configure NTP Authentication keys

keies: object

Authentication Key Table

key: object[]

Authentication key for trusted time sources

object
key-number: string

Authentication Key number

authentication-key: string

Authentication key - maximum 32 characters

trusted-keies: object

Key numbers for trusted time sources

trusted-key: object[]

Configure NTP trusted key

object
key-number: string

Key number

enable: null

Enable NTP authentication keys

Example
{
  "keies": {
    "key": [
      {
        "key-number": "string",
        "authentication-key": "string"
      }
    ]
  },
  "trusted-keies": {
    "trusted-key": [
      {
        "key-number": "string"
      }
    ]
  },
  "enable": [ null ]
}

a1_keies_schema:

Authentication Key Table

key: object[]

Authentication key for trusted time sources

object
key-number: string

Authentication Key number

authentication-key: string

Authentication key - maximum 32 characters

Example
{
  "key": [
    {
      "key-number": "string",
      "authentication-key": "string"
    }
  ]
}

a1_key_schema:

key-number: string

Authentication Key number

authentication-key: string

Authentication key - maximum 32 characters

Example
{
  "key-number": "string",
  "authentication-key": "string"
}

a1_trusted-keies_schema:

Key numbers for trusted time sources

trusted-key: object[]

Configure NTP trusted key

object
key-number: string

Key number

Example
{
  "trusted-key": [
    {
      "key-number": "string"
    }
  ]
}

a1_trusted-key_schema:

key-number: string

Key number

Example
{
  "key-number": "string"
}

a1_passive_schema:

Configure NTP passive associations

enable: null

Enable NTP Passive associations

Example
{
  "enable": [ null ]
}

a1_interface-tables_schema:

NTP per interface configuration

interface-table: object[]

NTP per interface configuration

object
interface: object[]

Name of the interface

object
interface: string

interface

disable: null

Disable NTP

interface-broadcast: object

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

interface-multicast: object

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

vrf-name: string

VRF name

Example
{
  "interface-table": [
    {
      "interface": [
        {
          "interface": "string",
          "disable": [ null ],
          "interface-broadcast": {
            "broadcast-client": [ null ],
            "broadcast-servers": {
              "broadcast-server": [
                {
                  "broadcast-type": "string",
                  "ntp-version": "string",
                  "authentication-key": "string",
                  "address": "string"
                }
              ]
            }
          },
          "interface-multicast": {
            "multicast-clients": {
              "multicast-client": [
                {
                  "ip-address": "string"
                }
              ]
            },
            "multicast-servers": {
              "multicast-server": [
                {
                  "version": "string",
                  "authentication-key": "string",
                  "ip-address": "string",
                  "ttl": "string"
                }
              ]
            }
          }
        }
      ],
      "vrf-name": "string"
    }
  ]
}

a1_interface-table_schema:

interface: object[]

Name of the interface

object
interface: string

interface

disable: null

Disable NTP

interface-broadcast: object

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

interface-multicast: object

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

vrf-name: string

VRF name

Example
{
  "interface": [
    {
      "interface": "string",
      "disable": [ null ],
      "interface-broadcast": {
        "broadcast-client": [ null ],
        "broadcast-servers": {
          "broadcast-server": [
            {
              "broadcast-type": "string",
              "ntp-version": "string",
              "authentication-key": "string",
              "address": "string"
            }
          ]
        }
      },
      "interface-multicast": {
        "multicast-clients": {
          "multicast-client": [
            {
              "ip-address": "string"
            }
          ]
        },
        "multicast-servers": {
          "multicast-server": [
            {
              "version": "string",
              "authentication-key": "string",
              "ip-address": "string",
              "ttl": "string"
            }
          ]
        }
      }
    }
  ],
  "vrf-name": "string"
}

a1_interface_schema:

interface: string

interface

disable: null

Disable NTP

interface-broadcast: object

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

interface-multicast: object

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

Example
{
  "interface": "string",
  "disable": [ null ],
  "interface-broadcast": {
    "broadcast-client": [ null ],
    "broadcast-servers": {
      "broadcast-server": [
        {
          "broadcast-type": "string",
          "ntp-version": "string",
          "authentication-key": "string",
          "address": "string"
        }
      ]
    }
  },
  "interface-multicast": {
    "multicast-clients": {
      "multicast-client": [
        {
          "ip-address": "string"
        }
      ]
    },
    "multicast-servers": {
      "multicast-server": [
        {
          "version": "string",
          "authentication-key": "string",
          "ip-address": "string",
          "ttl": "string"
        }
      ]
    }
  }
}

a1_interface-multicast_schema:

Configure NTP multicast service

multicast-clients: object

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

multicast-servers: object

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

Example
{
  "multicast-clients": {
    "multicast-client": [
      {
        "ip-address": "string"
      }
    ]
  },
  "multicast-servers": {
    "multicast-server": [
      {
        "version": "string",
        "authentication-key": "string",
        "ip-address": "string",
        "ttl": "string"
      }
    ]
  }
}

a1_multicast-clients_schema:

Configures multicast client peers

multicast-client: object[]

Listen to NTP multicasts

object
ip-address: string

IP address of a multicast group

Example
{
  "multicast-client": [
    {
      "ip-address": "string"
    }
  ]
}

a1_multicast-client_schema:

ip-address: string

IP address of a multicast group

Example
{
  "ip-address": "string"
}

a1_multicast-servers_schema:

Configures multicast server peers

multicast-server: object[]

Configure NTP multicast group server peer

object
version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

Example
{
  "multicast-server": [
    {
      "version": "string",
      "authentication-key": "string",
      "ip-address": "string",
      "ttl": "string"
    }
  ]
}

a1_multicast-server_schema:

version: string

NTP version

authentication-key: string

Authentication key

ip-address: string

IP address of a multicast group

ttl: string

TTL

Example
{
  "version": "string",
  "authentication-key": "string",
  "ip-address": "string",
  "ttl": "string"
}

a1_interface-broadcast_schema:

Configure NTP broadcast service

broadcast-client: null

Listen to NTP broadcasts

broadcast-servers: object

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

Example
{
  "broadcast-client": [ null ],
  "broadcast-servers": {
    "broadcast-server": [
      {
        "broadcast-type": "string",
        "ntp-version": "string",
        "authentication-key": "string",
        "address": "string"
      }
    ]
  }
}

a1_broadcast-servers_schema:

Configure NTP broadcast

broadcast-server: object[]

Configure NTP broadcast server

object
broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

Example
{
  "broadcast-server": [
    {
      "broadcast-type": "string",
      "ntp-version": "string",
      "authentication-key": "string",
      "address": "string"
    }
  ]
}

a1_broadcast-server_schema:

broadcast-type: string

Broadcast Type

ntp-version: string

NTP version

authentication-key: string

Authentication key

address: string

Destination broadcast IPv4 address

Example
{
  "broadcast-type": "string",
  "ntp-version": "string",
  "authentication-key": "string",
  "address": "string"
}

a1_access-group-tables_schema:

Control NTP access

access-group-table: object[]

Control NTP access

object
vrf-name: string

VRF name

access-group-af-table: object[]

Configure NTP access address family

object
access-group: object[]

Configure NTP access group

object
access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

af: string ipv4, ipv6

Address family

Example
{
  "access-group-table": [
    {
      "vrf-name": "string",
      "access-group-af-table": [
        {
          "access-group": [
            {
              "access-group-type": "string",
              "access-list-name": "string"
            }
          ],
          "af": "string"
        }
      ]
    }
  ]
}

a1_access-group-table_schema:

vrf-name: string

VRF name

access-group-af-table: object[]

Configure NTP access address family

object
access-group: object[]

Configure NTP access group

object
access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

af: string ipv4, ipv6

Address family

Example
{
  "vrf-name": "string",
  "access-group-af-table": [
    {
      "access-group": [
        {
          "access-group-type": "string",
          "access-list-name": "string"
        }
      ],
      "af": "string"
    }
  ]
}

a1_access-group-af-table_schema:

access-group: object[]

Configure NTP access group

object
access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

af: string ipv4, ipv6

Address family

Example
{
  "access-group": [
    {
      "access-group-type": "string",
      "access-list-name": "string"
    }
  ],
  "af": "string"
}

a1_access-group_schema:

access-group-type: string peer, serve, serve-only, query-only

Access group type

access-list-name: string

Access list name - maximum 32 characters

Example
{
  "access-group-type": "string",
  "access-list-name": "string"
}

TRAP-HOST-TABLE:

Common node of snmp, vrf

trap-hosts: object

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-hosts": {
    "trap-host": [
      {
        "encrypted-user-communities": {
          "encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-host": {
          "inform-encrypted-user-communities": {
            "inform-encrypted-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          },
          "inform-user-communities": {
            "inform-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          }
        },
        "ip-address": "string",
        "default-user-communities": {
          "default-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      }
    ]
  }
}

APPLIED-TO:

Common node of rule, rule-set

applied-to: object

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

CONTEXT-MAPPING-TABLE:

Common node of snmp, vrf

context-mappings: object

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

VAR-BIND-TABLE:

Common node of root-cause, non-root-cause

var-binds: object

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

CONTEXT-TABLE:

Common node of snmp, vrf

contexts: object

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "contexts": {
    "context": [
      {
        "context-name": "string"
      }
    ]
  }
}

a1_snmp_schema:

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

a1_encrypted-community-maps_schema:

Container class to hold clear/encrypted communitie maps

encrypted-community-map: object[]

Clear/encrypted SNMP community map

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "encrypted-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a1_encrypted-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a1_views_schema:

Class to configure a SNMPv2 MIB view

view: object[]

Name of the view

object
view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view": [
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

a1_view_schema:

view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

a1_logging_schema:

SNMP logging

threshold: object

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "threshold": {
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

a1_threshold_schema:

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

a1_administration_schema:

Container class for SNMP administration

default-communities: object

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

encrypted-communities: object

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-communities": {
    "default-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  "encrypted-communities": {
    "encrypted-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

a1_default-communities_schema:

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a1_default-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a1_encrypted-communities_schema:

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "encrypted-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a1_encrypted-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a1_agent_schema:

The heirarchy point for SNMP Agent configurations

engine-id: object

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "engine-id": {
    "remotes": {
      "remote": [
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

a1_engine-id_schema:

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "remotes": {
    "remote": [
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

a1_remotes_schema:

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote": [
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

a1_remote_schema:

remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

a1_trap_schema:

Class to hold trap configurations

queue-length: integer

Message queue length for each TRAP host

range:"1..5000"
throttle-time: integer

Set throttle time for handling traps

range:"50..1000" units:"millisecond"
timeout: integer

Timeout for TRAP message retransmissions

range:"1..600000" units:"millisecond"
Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

a1_drop-packet_schema:

SNMP packet drop config

unknown-user: null

Enable drop unknown user name

Example
{
  "unknown-user": [ null ]
}

a1_ipv6_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a1_tos_schema:

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

a1_ipv4_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a1_system_schema:

container to hold system information

chassis-id: string

String to uniquely identify this chassis

contact: string

identification of the contact person for this managed node

location: string

The physical location of this node

Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

a1_target_schema:

target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target-addresses": {
    "target-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  "vrf-names": {
    "vrf-name": [
      {
        "name": "string"
      }
    ]
  }
}

a1_targets_schema:

List of targets

target: object[]

Name of the target list

object
target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target": [
    {
      "target-addresses": {
        "target-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      "vrf-names": {
        "vrf-name": [
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

a1_vrf-names_schema:

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "vrf-name": [
    {
      "name": "string"
    }
  ]
}

a1_vrf-name_schema:

name: string

VRF Name

Example
{
  "name": "string"
}

a1_target-addresses_schema:

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

Example
{
  "target-address": [
    {
      "ip-address": "string"
    }
  ]
}

a1_target-address_schema:

ip-address: string

IPv4/Ipv6 address

Example
{
  "ip-address": "string"
}

a1_notification_schema:

Enable SNMP notifications

ntp: object

CISCO-NTP-MIB notification configuration

enable: null

Enable ciscoNtpMIB notification configuration

snmp: object

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

Example
{
  "ntp": {
    "enable": [ null ]
  },
  "snmp": {
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}

a1_correlator_schema:

Configure properties of the trap correlator

rules: object

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

rule-sets: object

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

buffer-size: integer

Configure size of the correlator buffer

range:"1024..2147483647" units:"byte"
Example
{
  "rules": {
    "rule": [
      {
        "non-root-causes": {
          "non-root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        "root-causes": {
          "root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "rule-sets": {
    "rule-set": [
      {
        "name": "string",
        "rulenames": {
          "rulename": [
            {
              "rulename": "string"
            }
          ]
        },
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

a1_rules_schema:

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "rule": [
    {
      "non-root-causes": {
        "non-root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      "root-causes": {
        "root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a1_rule_schema:

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "non-root-causes": {
    "non-root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  "root-causes": {
    "root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a1_root-causes_schema:

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a1_root-cause_schema:

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a1_var-binds_schema:

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-bind": [
    {
      "oid": "string",
      "match": {
        "index": "string",
        "value": "string"
      }
    }
  ]
}

a1_var-bind_schema:

oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "oid": "string",
  "match": {
    "index": "string",
    "value": "string"
  }
}

a1_match_schema:

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "index": "string",
  "value": "string"
}

a1_non-root-causes_schema:

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "non-root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a1_non-root-cause_schema:

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a1_applied-to_schema:

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "all": [ null ],
  "hosts": {
    "host": [
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

a1_hosts_schema:

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "host": [
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

a1_host_schema:

port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "port": "string",
  "ip-address": "string"
}

a1_rule-sets_schema:

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rule-set": [
    {
      "name": "string",
      "rulenames": {
        "rulename": [
          {
            "rulename": "string"
          }
        ]
      },
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a1_rule-set_schema:

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "name": "string",
  "rulenames": {
    "rulename": [
      {
        "rulename": "string"
      }
    ]
  },
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a1_rulenames_schema:

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rulename": [
    {
      "rulename": "string"
    }
  ]
}

a1_rulename_schema:

rulename: string

Rule name

Example
{
  "rulename": "string"
}

a1_bulk-stats_schema:

SNMP bulk stats configuration commands

memory: integer

per process memory limit in kilo bytes

range:"100..200000" units:"kilobyte"
transfers: object

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

objects: object

Configure an Object List

object: object[]

Name of the object List

object
object-list-name: string

Name of the object List

objects: object

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

type: null

Configure object list name

schemas: object

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "memory": "integer",
  "transfers": {
    "transfer": [
      {
        "retry": "integer",
        "transfer-schemas": {
          "transfer-schema": [
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  "objects": {
    "object": [
      {
        "object-list-name": "string",
        "objects": {
          "object": [
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  "schemas": {
    "schema": [
      {
        "schema-name": "string",
        "instance": {
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

a1_schemas_schema:

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema": [
    {
      "schema-name": "string",
      "instance": {
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

a1_schema_schema:

schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema-name": "string",
  "instance": {
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

a1_instance_schema:

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

a1_objects_schema:

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

Example
{
  "object": [
    {
      "oid": "string"
    }
  ]
}

a1_object_schema:

oid: string

Object name or OID

Example
{
  "oid": "string"
}

a1_transfers_schema:

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "transfer": [
    {
      "retry": "integer",
      "transfer-schemas": {
        "transfer-schema": [
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

a1_transfer_schema:

retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"minute"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "retry": "integer",
  "transfer-schemas": {
    "transfer-schema": [
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

a1_transfer-schemas_schema:

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

Example
{
  "transfer-schema": [
    {
      "schema-name": "string"
    }
  ]
}

a1_transfer-schema_schema:

schema-name: string

Schema that contains objects to be collected

Example
{
  "schema-name": "string"
}

a1_default-community-maps_schema:

Container class to hold unencrpted community map

default-community-map: object[]

Unencrpted SNMP community map name

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "default-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a1_default-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a1_overload-control_schema:

Set overload control params for handling incoming messages

drop-time: integer

Drop time in seconds for incoming queue (default 1 sec)

range:"0..300" units:"second"
throttle-rate: integer

Throttle time in milliseconds for incoming queue (default 500 msec)

range:"0..1000" units:"millisecond"
Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

a1_timeouts_schema:

SNMP timeouts

duplicates: integer

Duplicate request feature timeout

range:"0..20" units:"second" default:"1"
pdu-stats: integer

SNMP pdu statistics timeout

range:"1..10" units:"second" default:"2"
in-qdrop: integer

incoming queue drop feature timeout

range:"0..20" units:"second" default:"10"
subagent: integer

Sub-Agent Request timeout

range:"1..20" units:"second" default:"10"
Example
{
  "duplicates": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

a1_users_schema:

Define a user who can access the SNMP engine

user: object[]

Name of the user

object
v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "user": [
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

a1_user_schema:

v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

a1_vrfs_schema:

SNMP VRF configuration commands

vrf: object[]

VRF name

name: string

VRF name

Example
{
  "vrf": [
    {
      "name": "string",
      "context-mappings": {
        "context-mapping": [
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

a1_vrf_schema:

name: string

VRF name

Example
{
  "name": "string",
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

a1_trap-hosts_schema:

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-host": [
    {
      "encrypted-user-communities": {
        "encrypted-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      "inform-host": {
        "inform-encrypted-user-communities": {
          "inform-encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-user-communities": {
          "inform-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      "default-user-communities": {
        "default-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

a1_trap-host_schema:

encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-communities": {
    "encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-host": {
    "inform-encrypted-user-communities": {
      "inform-encrypted-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    "inform-user-communities": {
      "inform-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  "default-user-communities": {
    "default-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a1_encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_inform-host_schema:

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-communities": {
    "inform-encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-user-communities": {
    "inform-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a1_inform-user-communities_schema:

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_inform-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_inform-encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_inform-encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_default-user-communities_schema:

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "default-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_default-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_contexts_schema:

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "context": [
    {
      "context-name": "string"
    }
  ]
}

a1_context_schema:

context-name: string

Context Name

Example
{
  "context-name": "string"
}

a1_context-mappings_schema:

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping": [
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

a1_context-mapping_schema:

context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

a1_groups_schema:

Define a User Security Model group

group: object[]

Name of the group

object
name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "group": [
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

a1_group_schema:

name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

a1_mib_schema:

mib

Example